home *** CD-ROM | disk | FTP | other *** search
/ 8bitfiles.net/archives / archives.tar / archives / compuserve-file-archive / 01 New Uploads / VICE0130.ZIP / vice / README.DOS < prev    next >
Encoding:
Text File  |  1997-11-26  |  13.6 KB  |  328 lines
  1.  
  2.     
  3.                  VICE 0.13.0
  4.                  ~~~~~~~~~~~
  5.                  
  6.               MSDOS-specific information
  7.  
  8.                official VICE home page:
  9.             http://www.tu-chemnitz.de/~fachat/vice
  10.               
  11.  
  12.  
  13. [There is no real documentation for the MS-DOS version of VICE at the moment.
  14.  Please refer to the Unix manual (doc/MANUAL.html) for the main concepts.  This
  15.  file is only supposed to get you started.
  16.  
  17.  If you feel like helping us to maintain the MS-DOS version of the
  18.  documentation, you are of course welcome.  Just contact ettore@comm2000.it.]
  19.  
  20.  
  21. OVERVIEW
  22. --------
  23.  
  24. VICE is a set of emulators for the PET, VIC20 and C64 Commodore 8-bit machines
  25. running on MS-DOS, Windows 95 and Unix systems.
  26.  
  27. The C64 emulator is very advanced, and features a rather complete cycle-exact
  28. emulation of all the chips, including the VIC-II video controller, the two CIA
  29. interface adapters and the SID sound device.
  30.  
  31. On the other hand, the VIC20 and PET emulators are still under construction.
  32. They emulate the audio and the most important features in the video chips, but
  33. the emulation of the VIAs (Versatile Interface Adaptors) is not very accurate
  34. yet.  Anyway, this should be already enough for running most programs.
  35.  
  36. When running the VIC20 and C64 emulators, also a hardware-level emulation of
  37. the Commodore 1541 5"1/4 disk drive is available.
  38.  
  39.  
  40. SYSTEM REQUIREMENTS
  41. -------------------
  42.  
  43. This has not been tested thoroughly, but the minimum requirements should be:
  44.  
  45.  - a Pentium-class machine or better;
  46.  
  47.  - 8 Mbytes of RAM;
  48.  
  49.  - a register-compatible VGA graphics card (better if it is also SVGA and 
  50.    VESA-compliant);
  51.  
  52.  - MS-DOS 5.0 or later (or Windows 95).
  53.  
  54. Moreover, VICE optionally supports standard PC joysticks and the following 
  55. sound cards:
  56.  
  57.  - Creative Labs Sound Blaster series (1.0 through SB 16 and AWE32);
  58.  
  59.  - Gravis UltraSound (regular, MAX, and Plug and Play);
  60.    
  61.  - Media Vision Pro Audio Spectrum series (PAS, PAS+ and PAS16);
  62.  
  63.  - Microsoft Windows Sound System and compatible cards using the 
  64.    Crystal/Analog CODEC (most inexpensive 16-bit sound cards sold nowadays 
  65.    are WSS compatible).
  66.  
  67.  
  68. INSTALLATION
  69. ------------
  70.  
  71. There is no particular installation procedure for the MS-DOS version of VICE.
  72. Just unzip the archive by keeping the directory structure intact (you need to
  73. use `pkunzip -d' if you use PkZip).
  74.  
  75. VICE should be able to auto-detect most sound cards by itself, but there might
  76. be problems with some of them (e.g. Windows Sound System cards).  So it is a
  77. good idea to force a sound card setup by running the emulators with the
  78. `-dosoundsetup' option the first time you have installed VICE.  For example,
  79. type `x64 -dosoundsetup' at the DOS prompt, which will run the MIDAS sound
  80. setup before running the C64 emulator.
  81.  
  82. The only settings that are relevant in the MIDAS sound setup are the sound
  83. card type and IRQ/port settings.  The other ones are automatically set by the
  84. emulator as soon as the emulation is fired up.  The settings are saved in a
  85. `MIDAS.CFG' file in the VICE directory, so you do not have to do this more
  86. than once if you want to keep the same configuration.  Also notice that you do
  87. not have to configure the three emulators separately, as the same `MIDAS.CFG'
  88. file is used by all of them.
  89.  
  90. The joystick does not require calibration.  Just plug it in.
  91.  
  92.  
  93. HOW TO RUN THE EMULATORS
  94. ------------------------
  95.  
  96. There are three executables for the three PET, VIC20 and C64 emulators:
  97.  
  98.       x64.exe    the C64 emulator
  99.       xpet.exe    the PET emulator
  100.       xvic.exe    the VIC20 emulator
  101.  
  102. To run them, just type the corresponding name at the DOS prompt.
  103.  
  104. `xpet.exe' actually emulates 3 PET models (3032, 4032, 8032).  You can select
  105. which machine you want by loading the right kernal ROM image, with the
  106. `-kernal' command-line option.  In fact, `xpet' will compute the ROM checksum
  107. and then select the machine type accordingly, without the need to change other
  108. settings.  So you basically have to do:
  109.  
  110.       xpet -kernal kern3032    for the PET 3032 emulator
  111.       xpet -kernal kern4032     for the PET 4032 emulator
  112.       xpet -kernal kern8032     for the PET 8032 emulator (80 column)
  113.  
  114. As soon as the emulator is started (and the sound setup has been finished, if
  115. you have requested it), you should get the bootup screen of the emulated
  116. machine on your screen.
  117.  
  118. You can access the emulator menu by pressing `ESC'.  By pressing `ESC' again,
  119. you can go back to the emulation screen.
  120.  
  121.  
  122. KEYBOARD LAYOUT
  123. ---------------
  124.  
  125. The layout of the VIC20 and C64 keyboard is pretty much the same as the one of
  126. the real machine.  Some keys did not fit too well in the PC keyboard and had
  127. to be moved around.  These keys are:
  128.  
  129.     Alt        Commodore
  130.     Delete    Arrow Up
  131.     Insert    Pound
  132.     Home    CLR/HOME
  133.     Page Up    RESTORE
  134.  
  135. The PET keyboard layout is a bit more complicate and varies according to the
  136. model (``graphics'' keyboard for the 3032/4032, ``business'' keyboard for the
  137. 8032).
  138.  
  139. The following keys perform special actions:
  140.  
  141.     F12        soft reset
  142.     Ctrl-F12    hard reset (wipes out RAM)
  143.     PgUp    Restore
  144.  
  145. The joystick directions are emulated through the numeric keypad; the right
  146. Ctrl key or the 0 (zero) on the keypad emulate the fire button.
  147.  
  148.  
  149. THE EMULATOR MENU
  150. -----------------
  151.  
  152. In the emulator menu you can select items by using the cursor keys and
  153. pressing Enter or by hitting the corresponding highlighted initial.  If you
  154. move around with the cursor keys, a short description of the command appears
  155. on the bottom line.  Press ESC to exit a sub menu.
  156.  
  157. Here is a short list of what the various items do:  (for more information,
  158. refer to the Unix documentation)
  159.  
  160.  - Attach disk/tape image: attaches a disk or tape image for use in the
  161.    virtual cassette/disk drives.
  162.  
  163.  - Detach disk/tape image: detaches a disk or tape image from the drive.
  164.    Notice that, when a T64 tape image is attached, VICE emulates a pressed
  165.    PLAY button on the cassette recorder.  This should not do any harm in most
  166.    cases, but some programs do not like it; if you experience any weird
  167.    problems, try to detach the tape image after you have loaded it.
  168.  
  169.  - Change working directory: changes the directory for drive #11 and also
  170.    affects all the following commands.
  171.  
  172.  - Joystick settings (x64 only): allows you to select in which port the
  173.    emulated joysticks should be plugged in.
  174.  
  175.  - Video settings: this is a sub-menu from which you can specify the desired
  176.    refresh rate, enable/disable sprite collisions (on the C64) and select the
  177.    VGA mode you want.  The following resolutions are supported:
  178.  
  179.      320x200 (linear)
  180.      640x480 (linear, requires a VESA-compliant SVGA card)
  181.      360x240, 360x270, 376x282, 400x300 (planar)
  182.  
  183.    Warning: the planar resolutions might not work on your equipment!  Some
  184.    monitors do not like to be fed with strange frequencies, and although we
  185.    have never heard of any damages resulting from these resolutions, we cannot
  186.    give any warranties about that.
  187.  
  188.    Moreover, please notice that the mode-X resolutions are _much_ slower than
  189.    the linear ones, so the performance will be worse with them.  If you
  190.    install the Scitech Display Doctor (http://www.scitechsoft.com), also
  191.    360x240 will be linear (which is very useful) and will run nearly as fast
  192.    as 320x200 in many cases.  Unluckily, SDD is shareware and you will have
  193.    to pay for it.
  194.  
  195.    The VGA mode in the PET emulator is hard-coded: you will get 320x200 for
  196.    the 3032/4032 and 640x480 for the 8032.
  197.  
  198.    From this menu you can also enable or disable the video cache.  Notice that
  199.    on MS-DOS the video cache is not as useful as on X-Window.  Anyway, it
  200.    should make things faster when you work with text-mode applications (the 
  201.    difference in performance is bigger with the PET and VIC20 emulators).
  202.  
  203.  - Drive settings (C64/VIC20 only): this sub-menu specifies the parameters for
  204.    the hardware-level emulation of the 1541 disk drive.  If the programs you
  205.    are running do not need accurate emulation of the disk drive, keep the
  206.    ``true'' 1541 emulation turned off as it is much faster this way.  On the 
  207.    other hand, if you run games that require turboloaders or other features 
  208.    that are not supported by the fast disk-drive emulation you should keep it 
  209.    turned on.
  210.  
  211.    The 1541 ``idle method'' selects the way the 1541 CPU is emulated.  With
  212.    the ``Skip Cycles'' method, each time the serial line is accessed by the
  213.    computer the drive executes all the cycles since the last time it was
  214.    running; if the number of elapsed cycles is larger than a certain value,
  215.    the drive discards part of them.  With the ``Trap Idle'' method, the disk
  216.    drive is still emulated upon serial line accesses as with the previous
  217.    option, but it is also always emulated at least at the end of each screen
  218.    frame.  Moreover, if the drive gets into the DOS idle loop, only pending
  219.    interrupts are emulated to save time.
  220.  
  221.    The first option (``Skip cycles'') is usually better for performance, as
  222.    the drive is emulated as little as possible; on the other hand, you can
  223.    notice sudden slowdowns (when the drive executes several cycles at once).
  224.    Moreover, if the drive tries to get in sync with the computer in some weird
  225.    way and the computer does not access the serial line for a long time, it is
  226.    possible that some cycles are discarded and the sync is lost.  Notice that
  227.    this hack can have no effect on performance if one program continuously
  228.    reads the CIA ports, as the drive will have to be emulated in any case.
  229.  
  230.    The second option (``Trap idle'') is usually a bit slower, as at least
  231.    interrupts are always emulated, but always keeps the 1541 and the computer
  232.    in sync.  On the other hand, if a program installs a non-standard idle loop
  233.    in the drive, the 1541 CPU has to be emulated even when not necessary and
  234.    the global emulation speed is then much slower.
  235.  
  236.    If the ``Trap Idle'' method is enabled, the Scroll Lock LED of the keyboard
  237.    will emulate the 1541 drive LED.
  238.  
  239.  - Sound settings: specifies the parameters for the sound emulation.  Sound
  240.    playback only works if you have specified a 100% speed limit, and is turned
  241.    off with an error message otherwise.  Moreover, it eats some CPU speed.
  242.  
  243.  - Special options: allows you to enable the 1750 512K RAM Expansion
  244.    Emulation, the virtual IEEE488 interface and the CPU emulation detection
  245.    (all of these features are C64-only), and to specify a custom speed for the
  246.    emulation.
  247.  
  248.    Notice that the REU contents are saved in a `REU.C64' file in the same
  249.    directory as `X64.EXE', and are loaded back when you start the emulator
  250.    again.
  251.  
  252.  - Reset: resets the machine.  The are two types of reset: the ``hard'' one
  253.    which wipes out the RAM as if the machine had been turned off and on, and
  254.    the ``soft'' one which simply emulates a standard reset button and
  255.    preserves the memory contents.  The soft reset can be performed from the
  256.    emulation screen by pressing `F12'; the hard one by pressing `Ctrl-F12'.
  257.    ``Soft'' reset is sometimes not enough for certain games.
  258.  
  259.  - Monitor: enters a (very) simple machine-language monitor.  Type `x' to go
  260.    back to the emulation.
  261.  
  262.  - Write settings, Load settings: with these options, the current settings are
  263.    saved in a `VICERC' file in the VICE directory.  The settings for the three
  264.    emulators are saved in separate sections of the file and do not interfere
  265.    with each other.
  266.  
  267.  - VICE info: displays some information about the authors, the copyright and
  268.    the GNU License;
  269.  
  270.  - Quit: exits the emulator.
  271.  
  272.  
  273. CONTACTS
  274. --------
  275.  
  276. You can always find the latest news about VICE at the official VICE home
  277. page:
  278.  
  279.   http://www.tu-chemnitz.de/~fachat/vice
  280.  
  281. Also the public patches and beta releases will be available there, so you
  282. might want to have a look at it periodically.  If you are going to report a
  283. bug, please check those pages first; it is possible that the problem you
  284. encountered has already been fixed in a more recent version.  Also notice
  285. that, since VICE is released under the GNU General Public License, the sources
  286. are available from the home page too.
  287.  
  288. If you want to report bugs, make suggestions or contribute to the project,
  289. e-mail one of the following people:
  290.  
  291.   Teemu Rantanen (tvr@cs.hut.fi)  for the sound stuff;
  292.  
  293.   Andre' Fachat (fachat@physik.tu-chemnitz.de)  for the PETs;
  294.  
  295.   Ettore Perazzoli (ettore@comm2000.it)  for everything else.
  296.  
  297.  
  298. COPYRIGHT
  299. ---------
  300.  
  301. VICE is Copyright (c) 1993-1997 Ettore Perazzoli, Teemu Rantanen,
  302. Andre' Fachat, Jouko Valta, Jarkko Sonninen and Daniel Sladic.
  303.  
  304.    This program is free software; you can redistribute it and/or modify 
  305.    it under the terms of the GNU General Public License as published by 
  306.    the Free Software Foundation; either version 2 of the License, or 
  307.    (at your option) any later version.
  308.     
  309.    This program is distributed in the hope that it will be useful, 
  310.    but WITHOUT ANY WARRANTY; without even the implied warranty of 
  311.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
  312.    GNU General Public License for more details. 
  313.     
  314.    You should have received a copy of the GNU General Public License 
  315.    along with this program; if not, write to the Free Software 
  316.    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 
  317.  
  318. The MS-DOS version of VICE was made possible by two great libraries:
  319.  
  320.   - Allegro, a Game Programming Library by Shawn Hargreaves
  321.     (http://talula.demon.co.uk/allegro);
  322.  
  323.   - MIDAS Digital Audio System, a sound library for MS-DOS/Windows/Linux by
  324.     Petteri Kangaslampi and Jarno Paanen (http://www.s2.org/midas).
  325.  
  326. There have also been contributions from several people around the world: look
  327. at the Unix documentation or at the ``VICE Info'' command for a complete list.
  328.